Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix: Update the documentation of wp_get_active_and_valid_plugins() #7632

Open
wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Fix: Update the documentation of wp_get_active_and_valid_plugins() #7632

wants to merge 1 commit into from

Conversation

Debarghya-Banerjee
Copy link

@Debarghya-Banerjee Debarghya-Banerjee commented Oct 23, 2024 •
edited
Loading

Trac Ticket: Core-49599

Overview

  • This pull request aims to improve the documentation for the wp_get_active_and_valid_plugins() function in wp-includes/load.php. The current documentation incorrectly states that the function returns paths to plugin files "relative to the plugins directory." This wording can lead to confusion, as the function actually returns absolute paths to the active plugin files.

Changes Made

  • Updated the @return annotation in the function's documentation to clarify that it returns an array of absolute paths to plugin files.

  • Added a note explicitly stating that these paths are not relative to the plugins directory.

Rationale

  • Providing accurate documentation is crucial for developers using the WordPress API. By clearly indicating that the paths returned by this function are absolute, we can help prevent potential confusion and errors when developers attempt to work with plugin paths. This change aligns with the actual functionality of the method and enhances the overall clarity of the API documentation.

Impact

  • This change is purely a documentation update and will not affect existing functionality or backward compatibility. It aims to provide clearer guidance to developers, thereby improving their experience when working with WordPress plugins.

@github-actions GitHub Actions
Copy link

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props debarghyabanerjee.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@github-actions GitHub Actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@Debarghya-Banerjee